Skip to content

docs(skills): improve drafting skills from signal log patterns 2026-08-03 - #454

Closed
oz-by-warp[bot] wants to merge 6 commits into
mainfrom
docs/improve-drafting-skills-2026-08-03
Closed

docs(skills): improve drafting skills from signal log patterns 2026-08-03#454
oz-by-warp[bot] wants to merge 6 commits into
mainfrom
docs/improve-drafting-skills-2026-08-03

Conversation

@oz-by-warp

@oz-by-warp oz-by-warp Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Patterns addressed

  1. ui_label_accuracy / source verification (human feedback across 14+ clean PRs, including 399, 401, 402, 404, 405)
    • Reviewers repeatedly corrected invented or stale CLI flags, permission defaults, and UI chrome that did not match warp-internal / shipped product behavior.
  2. Durable vs ephemeral UI detail (human feedback across multiple PRs, especially 399 and 404)
    • Humans trimmed glyph-color inventories, layout narration, and other presentation detail that drifts; agents should document durable workflows and shortcuts instead.
  3. Availability / platform honesty (human feedback on content_structure and feature_status_accuracy, e.g. 373, 374)
    • Preview-only, platform-limited, or interactive-only behavior was sometimes written as generally available.
  4. Team-wide / admin effects for integrations (human feedback on missing_context, e.g. 281, 338)
    • Integration drafts often omitted who can install, whether teammates get access immediately, and per-user auth steps.
  5. Related pages dead-ends (human feedback on link_quality, e.g. 281, 295, 407)
    • New feature/integration pages shipped without sibling or next-step cross-links.

Signal window: last 30 days (2026-07-04 → 2026-08-03).
Primary source: GitHub human review comments and verdicts on agent-coauthored merged PRs (noise from Oz /oz-review template verdicts filtered out).
Oz [SIGNAL:style-lint] / [SIGNAL:pr-review] markers: 0 found in drafting-related run conversations (inner loop still not emitting markers reliably).
Standing signal-log PR: #433

Improvement targets

  • .agents/skills/draft_docs/SKILL.md — require source/live verification for labels/flags/defaults; add durable-UI, availability, team-access, and Related pages rules plus checklist items (applies to all drafting skills that route through draft_docs).
  • .agents/templates/feature-doc.md — bracket instructions for platform/preview limits, source-verified procedures, integration admin/access prerequisites, and required Related pages.
  • .agents/templates/guide-page.md — required VideoEmbed title, team-tool access prerequisites, and durable prompt/UI guidance.

Patterns reviewed but not acted on

  • callout / settings_path / content_structure (chronology, Troubleshooting placement) — already proposed in open PR docs(skills): improve drafting skills from signal log patterns 2026-08-01 #450; not duplicated here.
  • list_format / heading_specificity / terminology / scannability — already covered by existing step 6.5 rules and glossary guidance; remaining hits were page-specific accuracy.
  • frontmatter {{TOKEN}} substitution bugs — appears to be a build/transform issue called out in human replies (tokens not substituted), not a missing drafting-skill example; needs eng follow-up rather than another skill bullet.
  • general — heterogeneous product-accuracy feedback; no single skill edit would prevent it.
  • missing_media — mixed human preference (add screenshot vs land without media); PR 450 already tightens screenshot discipline.

Open questions for human review

  1. Should source verification be a hard blocker (omit unverified claims) even when only a PRD is available and warp-internal is not checked out? Resolved: not a hard blocker. The agent may omit the claim or keep it with an inline {/* VERIFY: ... */} marker, but reporting is now mandatory — draft_docs step 9.5 requires every unverified claim to be listed in an ## Unverified claims section of the PR description (or in the response for local sessions), and create_pr requires that section even when the list is empty.
  2. Is “Related pages required on every new feature/integration page” too strict for thin stub pages that will grow later?
  3. Inner-loop SIGNAL emission is still 0/30 days — worth a dedicated fix so style_lint/pr-review counts feed this loop automatically?
  4. Open PR docs(skills): improve drafting skills from signal log patterns 2026-08-01 #450 overlaps thematically (callouts/orientation/structure); consider merging docs(skills): improve drafting skills from signal log patterns 2026-08-01 #450 first, then this PR, or combining after review.

Test plan

  • git diff --check clean
  • YAML frontmatter parse check on changed skill/template files
  • Human review of whether the new rules match intended style guide emphasis

Conversation: https://app.warp.dev/conversation/23ca1da7-5292-48dc-bb3d-bb8a337eb730
Run: https://app.warp.dev/conversation/23ca1da7-5292-48dc-bb3d-bb8a337eb730
This PR was generated with Oz.

@vercel

vercel Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 4, 2026 4:51pm

Request Review

@cla-bot cla-bot Bot added the cla-signed label Aug 3, 2026
@hongyi-chen
hongyi-chen requested a review from rachaelrenk August 3, 2026 17:50
@hongyi-chen
hongyi-chen marked this pull request as ready for review August 3, 2026 17:50
@oz-for-oss

oz-for-oss Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR updates the docs drafting skill and feature/guide templates to require source or live-product verification for user-facing labels and flags, prefer durable behavior over ephemeral UI details, state availability limits, cover team/admin effects for integrations, and strengthen related-page expectations.

Concerns

  • No blocking concerns found in the attached diff. The supplemental security pass found no changed code or configuration introducing security-relevant risk, and spec_context.md reports that no approved or repository spec context exists for spec-drift review.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

…r skill

Co-Authored-By: Oz <oz-agent@warp.dev>
- **Document durable behavior, not ephemeral chrome** — Prefer workflows, shortcuts, and outcomes that stay true when styling shifts. Drop glyph colors, pixel-level layout narration, and other pure presentation detail unless the reader must recognize them to succeed. ✅ "Press `Ctrl+C` once to stop the in-progress response." ❌ a full inventory of pending/running/failed glyph colors
- **State availability honestly** — If a capability is preview-only, platform-limited, interactive-only, or not yet in cloud agents, say so next to the claim. Never describe limited-preview behavior as generally available. ✅ "Linux post-processing adds smart cut; macOS applies a uniform speedup." ❌ listing smart cut as a property of every recording
- **Cover team-wide and admin effects** — For integrations and team features, state who can install, whether every teammate gets access immediately, and any per-user auth or admin steps on the external system. ✅ "A Jira admin must install the app; each teammate links their own account for run attribution." ❌ setup steps that only describe the installer's happy path
- **Related pages are required on new pages** — End new feature, integration, and guide pages with a Related pages (or Next steps) section. Link siblings and the natural next workflow so the page does not dead-end. ✅ Integrations overview + Agent Management Panel + a sibling Slack/Linear page ❌ no cross-links after Troubleshooting

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This rule may be too strict for thin and newer stub pages that will be expanded on later. Update rule to include some flexibility around this. If there a logical and valuable next step exists, we should include that on the docs page.

Resolves the open question on source verification: keep the escape hatch
for drafts written without warp-internal/warp-server access, but make it
non-skippable. Unverified UI labels, flags, defaults, and eligibility
claims must be marked inline and surfaced in an Unverified claims section
of the PR description (or in the response for local sessions).

Co-Authored-By: Warp Agent <agent@warp.dev>
@rachaelrenk

Copy link
Copy Markdown
Contributor

Superseded by #487, which consolidates this PR together with the other stacked improve-drafting-skills PRs (#450, #454, #468, #484).

All four edited .agents/skills/draft_docs/SKILL.md and conflicted with each other, so none could merge cleanly. The patterns from this PR are carried over in #487 — overlapping rules were merged rather than stacked, and anything already superseded on main was dropped.

Root cause: the agent's schedule used 0 17 1-7 * 1, which is not "first Monday." Cron ORs day-of-month with day-of-week, so it fired roughly 11 times a month. #487 fixes the cron, adds a first-week guard, and gives the agent a single standing PR so this cannot recur.

@rachaelrenk rachaelrenk closed this Aug 6, 2026
rachaelrenk added a commit that referenced this pull request Aug 7, 2026
…ements (#487)

* docs(skills): reduce automation noise and consolidate drafting improvements

Recurring docs agents were producing more PRs and Slack messages than the
team could absorb. Three systemic causes, plus a batch of GitBook-era
migration artifacts that left several skills unable to run as written.

Shared conventions (skill-authoring-guidelines.md):
- Add "One standing PR per automation": stable branch and title, look
  before creating, add to the existing PR rather than opening another.
- Invert "Slack notifications" to actionable-only. The old rule required
  posting on every run and was the direct cause of the channel noise. Its
  silent-failure rationale is preserved by requiring a run log instead.
- Rewrite "Log availability" so outer loops read the log branch rather
  than main, and never merge the standing log PR as a workflow step.

Cron correctness:
- `0 17 1-7 * 1` is not "first Monday". Cron ORs day-of-month with
  day-of-week, so it fired ~11 times a month and produced four
  conflicting PRs in six days. Replace with `0 17 * * 1` plus an
  in-skill first-week guard in improve-drafting-skills,
  improve-aeo-crosslink-skill, and improve-404-monitor-skill.

PR reuse applied to: improve-drafting-skills, weekly-404-monitor,
afdocs-fix, sync-error-docs, sync_terminology, sync-openapi-spec,
improve-aeo-crosslink-skill, improve-404-monitor-skill. update-changelog
keeps one PR per release (correct) but now detects stacked release PRs.

Slack volume: aeo_crosslink_audit no longer posts on no-change runs;
weekly-404-monitor gates on threshold and folds its Phase 2 results into
a single message instead of two; afdocs-audit posts only on regression or
a blocked audit, backed by a new run log for the baseline.

Migration artifacts: a find-and-replace during the GitBook-to-Astro move
substituted descriptions into file paths. sync-error-docs referenced
`astro.config.mjs (sidebar config)` and `vercel.json (redirects)` as real
paths, had an invalid grep, and still called the GitBook API - it could
not have succeeded. Also corrected the sidebar location to src/sidebar.ts,
dropped the GITBOOK_TOKEN dependency, and fixed dead
`.warp/references/terminology.md` paths in four skills.

Consolidates PRs #450, #454, #468, and #484, which all edited
draft_docs/SKILL.md and conflicted with each other. Overlapping patterns
were merged rather than stacked, and PR #468's frontmatter-description
edits were dropped as already superseded on main.

Co-Authored-By: Warp Agent <agent@warp.dev>

* docs(skills): document the deployed monthly cron for improve-drafting-skills

The schedule was deployed as `0 15 1 * *` (the 1st of each month) rather
than the `0 17 * * 1` + first-week-guard combination the skill documented.
Both are correct and both fire exactly once a month, but the docs and the
deployed schedule disagreed.

Documented the deployed expression. Restricting only day-of-month is
unambiguous because day-of-week stays `*`, so there is no ORing hazard. The
tradeoff is noted: the 1st can land on a weekend, delaying review.

Kept the first-week guard as a safety net and explained why, since it no
longer trips on its own: it is what would narrow a day-of-week expression
back to the first Monday, and it contains the blast radius if the
day-of-month/day-of-week ORing mistake is ever reintroduced. Reworded the
guard's skip message, which still referenced 'first Monday'.

Co-Authored-By: Warp Agent <agent@warp.dev>

* docs(skills): treat a log-branch fetch failure as blocked, not a stale fallback

Review catch on improve-aeo-crosslink-skill: its step 0 said to fall back to
the log copy in the current checkout when the branch fetch fails. That copy
comes from `main` — precisely the truncated history the branch read exists to
avoid — so the fallback reintroduced the problem this PR set out to fix. The
file also contradicted itself: its Slack section already listed 'could not
fetch the log branch' as a blocked-run example while step 0 said not to abort.

The failure mode is quiet, which is what makes it worth fixing. A short log
still parses; only the counts change. The run then either drops below the
8-entry minimum and reports 'too early to analyze', or clears the minimum on
stale entries and proposes skill edits from an incomplete picture. Both look
like ordinary outcomes, so nobody investigates.

Both outer loops that read a log branch now stop before analysis on a fetch
failure and post the blocked-run message. improve-drafting-skills already had
this behavior documented and is unchanged.

Also generalized the rule in the authoring guidelines, since this is a class of
bug rather than a one-off: do not adopt a fallback that is quieter but less
correct than failing. The test is whether the fallback can change the answer
ratherratherratherratherratherratherratherratherratherratherratherratverage
transparently — proceeding on one source signal and recording the gap — remain
fine, because the reader can see what was missing.

Co-Authored-By: Warp Agent <agent@warp.dev>

---------

Co-authored-by: Warp Agent <agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants